/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2011, Salzburg Research. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of the KiWi Project nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Contributor(s):
 * sschaffe
 *
 * File Info:
 * User: sschaffe
 * Date: 2011/01/07
 * Time: 10:03
 *
 * Project: KiWi2, kiwi-core module
 */

package kiwi.core.model.content;

import kiwi.core.model.Constants;
import kiwi.core.model.annotations.RDF;
import kiwi.core.model.annotations.RDFType;
import kiwi.core.model.entity.KiWiFacade;
import kiwi.core.model.rdf.KiWiResource;

import java.util.Date;
import java.util.Locale;

/**
 * Add file description here!
 * <p/>
 * User: sschaffe
 */
@RDFType(Constants.NS_KIWI_CORE+"ContentItem")
public interface ContentItem extends KiWiFacade {


    /**
     * Return the localised title of this content item. Currently, the title is represented by the
     * RDF label of the corresponding resource; the method thus just delegates to KiWiResource.getLabel(Locale).
     * @return
     */

    @RDF(Constants.NS_KIWI_CORE+"title")
    public String getTitle();

    /**
     * Set the localised title of this content item. Currently, the title is represented by the
     * RDF label of the corresponding resource; the method thus just delegates to KiWiResource.setLabel(Locale,String).
     * @param title
     */
    public void setTitle(String title);


    /**
     * Return the content object related to the provided language.
     * @return
     */
    @RDF(Constants.NS_KIWI_CORE+"hasTextContent")
    public TextContent getTextContent();

    /**
     * Set the content object for this content item and the provided language.
     * @param content
     */
    public void setTextContent(TextContent content);


    /**
     * @return the mediaContent
     */
    @RDF(Constants.NS_KIWI_CORE+"hasMediaContent")
    public MediaContent getMediaContent();

    /**
     * @param mediaContent the mediaContent to set
     */
    public void setMediaContent(MediaContent mediaContent);



    /**
     * Return the locale describing the language this content is represented in.
     * @return
     */
    @RDF(Constants.NS_KIWI_CORE+"language")
    public Locale getLanguage();

    /**
     * Set the locale describing the language this content is represented in.
     * @param language
     */
    public void setLanguage(Locale language);


    /**
     * @return the created
     */
    @RDF(Constants.NS_KIWI_CORE+"createdOn")
    public Date getCreated();

    /**
     * @param created the created to set
     */
    public void setCreated(Date created);

    /**
     * @return the modified
     */
    @RDF(Constants.NS_KIWI_CORE+"modifiedOn")
    public Date getModified();

    /**
     * @param modified the modified to set
     */
    public void setModified(Date modified);


    /**
     * @return the author
     */
    @RDF(Constants.NS_KIWI_CORE+"hasAuthor")
    public KiWiResource getAuthor();

    /**
     * @param author the author to set
     */
    public void setAuthor(KiWiResource author);


    /**
     * Return the tags of this content item. Maps to the hgtags:taggedWithTag property.
     * @return
     */
//    @RDF(Constants.NS_HGTAGS+"taggedWithTag")
//    public List<Tag> getTags();

}
